<!doctype html>

<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>menuitem.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
  </script>

  <script src="static/js/doc.js">
  </script>

  <meta charset="utf8">
</head>

<body onload="prettyPrint()">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>

<div class="clear"></div>

<h2><a href="closure_goog_ui_menuitem.js.html">menuitem.js</a></h2>

<pre class="prettyprint lang-js">
<a name="line1"></a>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
<a name="line2"></a>// you may not use this file except in compliance with the License.
<a name="line3"></a>// You may obtain a copy of the License at
<a name="line4"></a>//
<a name="line5"></a>//     http://www.apache.org/licenses/LICENSE-2.0
<a name="line6"></a>//
<a name="line7"></a>// Unless required by applicable law or agreed to in writing, software
<a name="line8"></a>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
<a name="line9"></a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a name="line10"></a>// See the License for the specific language governing permissions and
<a name="line11"></a>// limitations under the License.
<a name="line12"></a>
<a name="line13"></a>// Copyright 2007 Google Inc. All Rights Reserved.
<a name="line14"></a>
<a name="line15"></a>/**
<a name="line16"></a> * @fileoverview A class for representing items in menus.
<a name="line17"></a> * @see goog.ui.Menu
<a name="line18"></a> *
<a name="line19"></a> */
<a name="line20"></a>
<a name="line21"></a>goog.provide(&#39;goog.ui.MenuItem&#39;);
<a name="line22"></a>
<a name="line23"></a>goog.require(&#39;goog.ui.Component.State&#39;);
<a name="line24"></a>goog.require(&#39;goog.ui.Control&#39;);
<a name="line25"></a>goog.require(&#39;goog.ui.ControlContent&#39;);
<a name="line26"></a>goog.require(&#39;goog.ui.MenuItemRenderer&#39;);
<a name="line27"></a>goog.require(&#39;goog.ui.registry&#39;);
<a name="line28"></a>
<a name="line29"></a>
<a name="line30"></a>/**
<a name="line31"></a> * Class representing an item in a menu.
<a name="line32"></a> *
<a name="line33"></a> * @param {goog.ui.ControlContent} content Text caption or DOM structure to
<a name="line34"></a> *     display as the content of the item (use to add icons or styling to
<a name="line35"></a> *     menus).
<a name="line36"></a> * @param {*} opt_model Data/model associated with the menu item.
<a name="line37"></a> * @param {goog.dom.DomHelper} opt_domHelper Optional DOM helper used for
<a name="line38"></a> *     document interactions.
<a name="line39"></a> * @param {goog.ui.MenuItemRenderer} opt_renderer Optional renderer.
<a name="line40"></a> * @constructor
<a name="line41"></a> * @extends {goog.ui.Control}
<a name="line42"></a> */
<a name="line43"></a>goog.ui.MenuItem = function(content, opt_model, opt_domHelper, opt_renderer) {
<a name="line44"></a>  goog.ui.Control.call(this, content, opt_renderer ||
<a name="line45"></a>      goog.ui.MenuItemRenderer.getInstance(), opt_domHelper);
<a name="line46"></a>  this.setValue(opt_model);
<a name="line47"></a>};
<a name="line48"></a>goog.inherits(goog.ui.MenuItem, goog.ui.Control);
<a name="line49"></a>
<a name="line50"></a>
<a name="line51"></a>// goog.ui.Component and goog.ui.Control implementation.
<a name="line52"></a>
<a name="line53"></a>
<a name="line54"></a>/**
<a name="line55"></a> * Returns the value associated with the menu item.  The default implementation
<a name="line56"></a> * returns the model object associated with the item (if any), or its caption.
<a name="line57"></a> * @return {*} Value associated with the menu item, if any, or its caption.
<a name="line58"></a> */
<a name="line59"></a>goog.ui.MenuItem.prototype.getValue = function() {
<a name="line60"></a>  var model = this.getModel();
<a name="line61"></a>  return model != null ? model : this.getCaption();
<a name="line62"></a>};
<a name="line63"></a>
<a name="line64"></a>
<a name="line65"></a>/**
<a name="line66"></a> * Sets the value associated with the menu item.  The default implementation
<a name="line67"></a> * stores the value as the model of the menu item.
<a name="line68"></a> * @param {*} value Value to be associated with the menu item.
<a name="line69"></a> */
<a name="line70"></a>goog.ui.MenuItem.prototype.setValue = function(value) {
<a name="line71"></a>  this.setModel(value);
<a name="line72"></a>};
<a name="line73"></a>
<a name="line74"></a>
<a name="line75"></a>/**
<a name="line76"></a> * Sets the menu item to be selectable or not.  Set to true for menu items
<a name="line77"></a> * that represent selectable options.
<a name="line78"></a> * @param {boolean} selectable Whether the menu item is selectable.
<a name="line79"></a> */
<a name="line80"></a>goog.ui.MenuItem.prototype.setSelectable = function(selectable) {
<a name="line81"></a>  this.setSupportedState(goog.ui.Component.State.SELECTED, selectable);
<a name="line82"></a>  if (this.isChecked() &amp;&amp; !selectable) {
<a name="line83"></a>    this.setChecked(false);
<a name="line84"></a>  }
<a name="line85"></a>
<a name="line86"></a>  var element = this.getElement();
<a name="line87"></a>  if (element) {
<a name="line88"></a>    this.renderer_.setSelectable(this, element, selectable);
<a name="line89"></a>  }
<a name="line90"></a>};
<a name="line91"></a>
<a name="line92"></a>
<a name="line93"></a>/**
<a name="line94"></a> * Sets the menu item to be checkable or not.  Set to true for menu items
<a name="line95"></a> * that represent checkable options.
<a name="line96"></a> * @param {boolean} checkable Whether the menu item is checkable.
<a name="line97"></a> */
<a name="line98"></a>goog.ui.MenuItem.prototype.setCheckable = function(checkable) {
<a name="line99"></a>  this.setSupportedState(goog.ui.Component.State.CHECKED, checkable);
<a name="line100"></a>
<a name="line101"></a>  var element = this.getElement();
<a name="line102"></a>  if (element) {
<a name="line103"></a>    this.renderer_.setCheckable(this, element, checkable);
<a name="line104"></a>  }
<a name="line105"></a>};
<a name="line106"></a>
<a name="line107"></a>
<a name="line108"></a>// Register a decorator factory function for goog.ui.MenuItems.
<a name="line109"></a>goog.ui.registry.setDecoratorByClassName(goog.ui.MenuItemRenderer.CSS_CLASS,
<a name="line110"></a>    function() {
<a name="line111"></a>      // MenuItem defaults to using MenuItemRenderer.
<a name="line112"></a>      return new goog.ui.MenuItem(null);
<a name="line113"></a>    });
</pre>


</body>
</html>
